Apply double check pattern to avoid race condition in LoggingService #11284
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes: https://dev.azure.com/devdiv/DevDiv/_workitems/edit/2320135/
Context
Reset()
method invocation sometimes causes exceptionSystem.IO.IOException: 'The handle is invalid.'
.Very likely it happens on application shutdown.
The assumption is:
Changes Made
To resolve this issue, the double-check pattern was implemented for the event fields.
This double-check approach prevents the 'invalid handle' exception from occurring during the race condition between component shutdown and the execution of the logging thread.
The changes include:
_dequeueEventDoubleCheckCopy
,_emptyQueueEventDoubleCheckCopy
, and_enqueueEventDoubleCheckCopy
fields to store local copies of the corresponding events.StartLoggingEventProcessing
method:LoggingEventProc
local function now uses the copy fields instead of the original event fields.CleanLoggingEventProcessing
method:By using local copies of the events within the logging thread, we ensure that the logging thread operates independently of the state of the original event fields.
The original event fields still serve as the single source of truth and are used to initialize the copies.
However, the copies are used exclusively by the logging thread, isolating it from any disposal that occurs on the main thread.
Testing
N/A